Get a list of timestreams

GET 
/timestreams

Get a list of timestreams with support for paging

Request

Query Parameters

pageSize integer

Default value: 25

The number of results per page

page integer

Default value: 1

The page of results to return

timestamp date-time

If not supplied, the current time is used

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

page integerrequired

The current page of results

pageSize integerrequired

The number of results per page

pageTotal integerrequired

The total number of pages

resultsTotal integerrequired

The total number of results

hasNextPage booleanrequired

True if there is a next page

hasPreviousPage booleanrequired

True if there is a previous page

results object[]required
The results for the current page
Array [
type stringrequired
Possible values: [TicketedEvent]
ticketedEvent object
venueName stringrequired
The name of the venue
competitionName stringrequired
The name of the competation
date date-timerequired
The date of the event
logoUrl stringrequired
The logo of the event
competitionLogoUrl stringrequired
The logo of the competition
]

Example (from schema)

{
  "page": 0,
  "pageSize": 0,
  "pageTotal": 0,
  "resultsTotal": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "results": [
    {
      "type": "TicketedEvent",
      "ticketedEvent": "string",
      "venueName": "string",
      "competitionName": "string",
      "date": "2024-01-11T21:22:38.993Z",
      "logoUrl": "string",
      "competitionLogoUrl": "string",
      "id": "string",
      "title": "string",
      "description": "string",
      "venue": "string",
      "timelines": {}
    }
  ]
}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Bad request]

A short, human-readable summary of the problem type.

status number

Possible values: [400]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

errors objectrequired
property name* object

Example (from schema)

{
  "type": "string",
  "title": "Bad request",
  "status": 400,
  "detail": "string",
  "instance": "string",
  "errors": {}
}

401

Access is unauthorized.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Unauthorized]

A short, human-readable summary of the problem type.

status number

Possible values: [401]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Unauthorized",
  "status": 401,
  "detail": "string",
  "instance": "string"
}

Loading...